/*
 * Copyright (c) 2011, Marc-Andre Ferland - madrang@gmail.com
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the The Warrent Team nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *     * This software is free for non-commercial use. You may not use this
 *       software, in whole or in part, in support of any commercial product
 *       without the express consent of the author.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE WARRENT TEAM BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
using System;
using System.Runtime.InteropServices;

namespace OsHelper.UsbNet.Descriptors
{
	/* Bits 0..1 Transfer Type
	 * Control = 00
	 * Isochronous = 01
	 * Bulk = 10
	 * Interrupt = 11
	 * 
	 * If Isochronous endpoint, 
	 * Bits 2..3 Synchronisation Type (Iso Mode)
	 * No Synchonisation = 00
	 * Asynchronous = 01
	 * Adaptive = 10
	 * Synchronous = 11
	 * 
	 * Bits 4..5 Usage Type (Iso Mode)
	 * Data Endpoint = 00
	 * Feedback Endpoint = 01
	 * Explicit Feedback Data Endpoint = 10
	 * Reserved = 11
	 * 
	 * If not an isochronous endpoint,
	 * Bits 2..5 are reserved and must be set to zero.
	 * 
	 * All other bits are reserved and must be reset to zero.
	 * Reserved bits must be ignored by the host.
	 */
	
	public enum TransferType : byte
	{
		Control = 0,
		Isochronous = 1,
		Bulk = 2,
		Interrupt = 3
	}
	
	public enum SynchronisationType : byte
	{
		NoSynchonisation = 0,
		Asynchronous = 1,
		Adaptive = 2,
		Synchronous = 3
	}
	
	public enum UsageType : byte
	{
		DataEndpoint = 0,
		FeedbackEndpoint = 1,
		ExplicitFeedbackDataEndpoint = 2,
		Reserved = 3
	}
	
	[StructLayout(LayoutKind.Explicit, Size = 1)]
	public struct EndpointAttributes
	{
		[FieldOffset(0)]
		private byte by_Value;
		
		private EndpointAttributes (byte Value)
		{
			this.by_Value = Value;
		}
		
		public static explicit operator byte(EndpointAttributes a)
		{
			return a.by_Value;
		}
		
		public static explicit operator EndpointAttributes(byte a)
		{
			return new EndpointAttributes (a);
		}
		
		public UsageType Usage {
			get {
				return (UsageType)(3 & (this.by_Value >> 4));
			}
			set {
				if(((byte)value & ~3) != 0)
					throw new ArgumentOutOfRangeException("value");
				
				this.by_Value |= (byte)(((byte)value & 3) << 4);
			}
		}
		
		public SynchronisationType Synchronisation {
			get {
				return (SynchronisationType)(3 & (this.by_Value >> 2));
			}
			set {
				if(((byte)value & ~3) != 0)
					throw new ArgumentOutOfRangeException("value");
				
				this.by_Value |= (byte)(((byte)value & 3) << 2);
			}
		}
		
		public TransferType Transfer {
			get {
				return (TransferType)(3 & this.by_Value);
			}
			set {
				if(((byte)value & ~3) != 0)
					throw new ArgumentOutOfRangeException("value");
				
				this.by_Value |= (byte)((byte)value & 3);
			}
		}
		
	}
}
